Add partial iOS support and fix most race-entry crashes by ykr2byfrqb-wq · Pull Request #684 · HarbourMasters/SpaghettiKart

ykr2byfrqb-wq · 2026-04-06T21:31:40Z

Summary

This PR brings the current iOS work together into one source-only branch.

Right now, the practical workaround for the remaining track crashes is to install the official MK64 Reloaded SpaghettiKart .o2r through the normal mods folder workflow on iPhone. With that mod in place, the current IPA works properly in on-device testing.

This PR also includes the libultraship submodule update required for the iOS changes, but it does not include any ROM assets, Nintendo content, or bundled third-party mod files.

iPhone Setup

download the official MK64 Reloaded SpaghettiKart .o2r
copy the .o2r file into Spaghettify/mods on the iPhone
launch the app after the file is in the mods folder

Build IPA

Prerequisites:

macOS with Xcode installed
CMake available in PATH
your own supported Mario Kart 64 ROM

Build steps:

clone this branch and update submodules
git clone --recurse-submodules <your-fork-or-branch-url>
if you already cloned without submodules, run:
git submodule update --init --recursive
generate the base asset archives from your own ROM:
- place your ROM where the project can use it as baserom.us.z64
- generate the asset archives with:
  cmake -S . -B build-cmake -GNinja
  cmake --build build-cmake --target ExtractAssets
- this produces the required mk64.o2r and spaghetti.o2r archives from your own ROM data
configure the iOS build:
cmake -S . -B build-ios-make -DCMAKE_BUILD_TYPE=Release -DIOS=ON -DSIGN_LIBRARY=OFF
build the app:
cmake --build build-ios-make --config Release
package an unsigned IPA:
mkdir -p build-ios-make/Payload
rm -rf build-ios-make/Payload/Spaghettify.app
cp -R build-ios-make/Spaghettify.app build-ios-make/Payload/Spaghettify.app
rm -f build-ios-make/SpaghettiKart-unsigned.ipa
zip -qry build-ios-make/SpaghettiKart-unsigned.ipa build-ios-make/Payload
the resulting unsigned IPA will be at:
build-ios-make/SpaghettiKart-unsigned.ipa

Asset Notes

the build requires user-generated mk64.o2r and spaghetti.o2r files
those files are generated from a user-provided supported Mario Kart 64 ROM
this PR does not include those archives or any ROM-derived content
on iOS, if the app still needs the ROM directly for extraction, the ROM filename expected by the app is baserom.us.z64

Current iOS status

testing on-device shows the current IPA works properly when MK64 Reloaded is added to the app's mods folder
this is a temporary workaround while the underlying track crash is still being investigated

Notes

This PR does not include any copyrighted Nintendo assets
This PR does not bundle MK64 Reloaded or any other third-party asset pack
Users must provide their own supported Mario Kart 64 ROM to build and run the project
Depends on Add partial iOS support Kenix3/libultraship#1056 for the submodule update

coco875 · 2026-04-06T21:33:15Z

 }

 std::vector<std::string> ListMods() {
-    const std::string main_path = Ship::Context::GetPathRelativeToAppDirectory(game_asset_file);


not sure about this change

The changes in this file feel like feature changes to me.

Prefer if this sort of change was discussed in the PR description (here is fine now) as to why/what this improves. Separate PR best but not required.

coco875

maybe clean a bit more debug or make it a bit more general ?

coco875 · 2026-04-06T21:34:27Z

                }
            }
        }
+#ifndef __IOS__


why it's needed ? can you add a comment

coco875 · 2026-04-06T21:36:03Z

 }

 void CM_TickEditor() {
+#ifdef __IOS__


seems like you disable editor for ios

coco875 · 2026-04-06T21:37:04Z

-    // Mobile: fallback to baserom.us.z64
-    if (!foundGame && !std::filesystem::exists(Ship::Context::GetPathRelativeToAppDirectory("baserom.us.z64"))) {
-        SPDLOG_ERROR("baserom not found");
+    // Mobile: fallback to baserom.us.z64 in the writable app directory.


hmm maybe would be better to use the system that search for a rom with the correct hash in a folder like on pc ?

ykr2byfrqb-wq · 2026-04-06T21:53:55Z

Cleaned this up.

removed the temporary iOS race debug instrumentation
removed the iOS-only editor tick/draw disable
replaced the iOS-specific gEditor.AddLight skip with an editor-enabled check instead
kept the current iOS actor/static-mesh render skips, but added comments since those are still part of the active crash workaround
also cleaned up the stray TargetConditionals.h include in the dependent libultraship PR

The libultraship update is now at Kenix3/libultraship#1056.

MegaMech · 2026-04-11T19:13:11Z

 #define STACKSIZE 0x2000
+#else
+#define STACKSIZE 0x10000
+#endif


revert, the stacks are unused

MegaMech · 2026-04-11T19:14:51Z

 }

 std::vector<std::string> ListMods() {
-    const std::string main_path = Ship::Context::GetPathRelativeToAppDirectory(game_asset_file);


The changes in this file feel like feature changes to me.

Prefer if this sort of change was discussed in the PR description (here is fine now) as to why/what this improves. Separate PR best but not required.

MegaMech · 2026-04-11T19:15:29Z

+
+        if (gEditor.IsEnabled()) {
+            gEditor.AddLight("Sun", nullptr, D_800DC610[1].l->l.dir);
+        }


MegaMech · 2026-04-11T19:17:20Z

 TrackSections* TrackSectionsClass::GetPointer() {
-    return TrackSectionsList.data();
+    PointerData = TrackSectionsList;
+    PointerData.push_back({});


Why the pushback of a blank array?

MegaMech · 2026-04-11T19:18:06Z

    std::vector<TrackSections> TrackSectionsList;
+
+  private:
+    std::vector<TrackSections> PointerData;


This is fine, but why is this change necessary?
Isn't it the same as TrackSectionsList?

MegaMech · 2026-04-11T19:21:34Z

+    return Ship::Context::GetPathRelativeToAppDirectory(fmt::format("controllerPak_file_{}.sav", file_no));
+#else
+    return Ship::Context::GetPathRelativeToAppDirectory("controllerPak_file_" + std::to_string(file_no) + ".sav");
+#endif


Just wondering if we should just use the second variation for everything and remove the format.h include and the ifdef?

MegaMech · 2026-04-11T19:23:13Z

    "src/port/*.h"
    "src/port/*.c"
    "src/port/*.cpp"
+    "src/port/*.mm"


What is .mm?

MegaMech · 2026-04-11T19:24:01Z

  set(STORYBOARD_FILE ${IOS_DIR}/Launch.storyboard)
-  set(IMAGE_FILES ${IOS_DIR}/PoweredBy.png)
-  set(ICON_FILES ${IOS_DIR}/Icon.png)
+  set(ICON_FILES ${CMAKE_CURRENT_SOURCE_DIR}/icon.png)


why image files removed? Not used?

MegaMech · 2026-04-11T19:30:06Z

One idea for the editor stuff. I believe switch and android remove the editor (iirc). Since this also does not need the editor,

we could

Skip enabling the editor
Add the if editor enabled check to the tick/draw
Add some sort of IsMobile() check behind the tick/draw

I'm also fine with the way it is for now. Perhaps change the define to IS_MOBILE or IS_HANDHELD_DEVICE or similar instead?

I think editor tick/draw also tests for editor enabled in those functions (but I don't remember)

MegaMech · 2026-04-11T19:32:26Z

The issue with the normal game assets not working was likely fixed in the latest lus version.

coco875 · 2026-04-11T19:33:11Z

and have been confirmed by the creator of the pr so it's not longer an issue

coco875 reviewed Apr 6, 2026

View reviewed changes

coco875 requested changes Apr 6, 2026

View reviewed changes

Add partial iOS support

f1222bb

ykr2byfrqb-wq force-pushed the ios-partial-support branch from aca32af to f1222bb Compare April 6, 2026 21:57

ykr2byfrqb-wq and others added 11 commits April 6, 2026 22:44

Prefer MK64 Reloaded on iOS

490e1f5

Remove iOS mod prompt experiment

2f9c0a2

Update libultraship submodule

f32fe9a

Fix clean iOS build dependencies

72504a2

Document iOS build steps

ec3f15f

Update libultraship submodule

92204b3

Fix iOS IPA packaging instructions

d39bfed

Update iOS build documentation

b818a74

Merge remote-tracking branch 'upstream/main' into pr/684

9051b85

fix error on linux

d08af78

Update CMakeLists.txt

af78cb1

MegaMech reviewed Apr 11, 2026

View reviewed changes

Conversation

ykr2byfrqb-wq commented Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

iPhone Setup

Build IPA

Asset Notes

Current iOS status

Notes

Uh oh!

coco875 Apr 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MegaMech Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

coco875 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ykr2byfrqb-wq commented Apr 6, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MegaMech Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MegaMech Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

MegaMech commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

MegaMech commented Apr 11, 2026

Uh oh!

coco875 commented Apr 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ykr2byfrqb-wq commented Apr 6, 2026 •

edited

Loading

coco875 Apr 6, 2026 •

edited

Loading

MegaMech Apr 11, 2026 •

edited

Loading

MegaMech Apr 11, 2026 •

edited

Loading

MegaMech Apr 11, 2026 •

edited

Loading

MegaMech commented Apr 11, 2026 •

edited

Loading